wfm-ux
TMF666-GET-Retrieve BillingAccount Details by ServiceNo
This operation allows to retrieve billing account details and additional contact information based on provided inputs such as serviceNo for JM.
Key Considerations common for both HFC & FTTH Implementation
- id-uriparam (i.e., ServiceNumber) is a mandatory input to retrieve both service details and billing account information from both the Liberate and Cerillion systems.
The ServiceNumber can be provided either with or without country code and BU codes.
- Examples: "18768335790" or "8768335790"
This functionality is currently implemented for the JM market.
- An additional response parameter 'sourceBSS' will be included to indicate whether the request is for Liberate or Cerillion.
- Using the provided serviceNo, the system will invoke the TMF638 – Retrieve Service Details API to obtain the corresponding billingAccount number and the response will also include additional service-related information.
- Other details such as account information and contact details will be retrieved using the TMF666 – GET Retrieve BillingAccount Details by Account No API.
The service object in the response will contain key service attributes including:
- serviceType: Type of service
- state: Current status of the service
- prepaidIndicator: Boolean flag indicating whether the service is prepaid or not
URL
https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/{businessId}/billingAccount/service/{id}URI Params
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| id | string | Service Number | Y |
Headers
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
cURL request for FTTH-Liberate
curl --location 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/billingAccount/service/18768335790' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b'Response for FTTH-Liberate
{
"id": "203004460000",
"billable": true,
"accountType": "R",
"description": "Residence",
"name": "MR Wayne Thompson",
"paymentStatus": "In Arrears",
"state": "W-Working",
"accountBalance": [
{
"amount": {
"value": 6498.75,
"unit": "JMD"
},
"balanceType": "NetPayable"
},
{
"amount": {
"value": 6498.75,
"unit": "JMD"
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2025-07-29T00:00:00.000Z"
}
},
{
"amount": {
"value": 6786.25,
"unit": "JMD"
},
"balanceType": "LastPayment Amount",
"validFor": {
"endDateTime": "2025-06-28T00:00:00.000Z"
}
},
{
"amount": {
"value": 6498.75,
"unit": "JMD"
},
"balanceType": "Overdue Amount"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "DepositRequired"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "WrittenOffAmount"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalQuery"
},
{
"amount": {
"value": 6498.75,
"unit": "JMD"
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "DepositHeld"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "Total Query Tax"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalAdjustmentCredit"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalDepositPaid"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalServiceChargeCredit"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalRewards"
},
{
"amount": {
"value": 0.00,
"unit": "JMD"
},
"balanceType": "TotalAvailablePointsAmount"
}
],
"billStructure": {
"cycleSpecification": {
"id": "H",
"paymentDueDate": "2025-07-29T00:00:00.000Z",
"billingDay": 9
},
"presentationMedia": [
{
"id": "E",
"name": "Electronic Bills"
},
{
"id": "E",
"name": "BillLanguage"
}
]
},
"paymentPlan": [
{
"priority": 0,
"planType": "W",
"status": "true",
"@type": "SupportsRecurringPayments"
}
],
"relatedParty": [
{
"id": "106847724",
"name": "MR Wayne Thompson",
"role": "customer",
"@type": "Customer",
"@referredType": "Customer",
"@baseType": "RelatedParty",
"characteristic": [
{
"name": "DocumentType",
"value": "TR"
},
{
"name": "DocumentNumber",
"value": "106847724"
},
{
"name": "Email",
"value": "jahson80@gmail.com"
},
{
"name": "Gender",
"value": "M"
},
{
"name": "Title",
"value": "MR",
"valueType": "string"
},
{
"name": "FirstName",
"value": "Wayne",
"valueType": "string"
},
{
"name": "LastName",
"value": "Thompson",
"valueType": "string"
},
{
"name": "OtherName",
"value": "UMAR",
"valueType": "string"
},
{
"name": "CompanyName",
"value": "Latoya Green",
"valueType": "string"
},
{
"name": "Date-Of-Birth",
"value": "12-May-1969 00:00:00",
"valueType": "string"
},
{
"name": "Customer Identity",
"valueType": "array",
"value": [
{
"DocumentType": "SS",
"DocumentNumber": "106847724",
"DocumentDescription": "Driving L No."
},
{
"DocumentType": "TR",
"DocumentNumber": "106847724",
"DocumentDescription": "TRN Number"
}
]
}
]
},
{
"id": "0",
"role": "MigratedAccount"
},
{
"id": "LIME",
"role": "legalEntity"
},
{
"@type": "Account",
"characteristic": [
{
"name": "BaseAccountType",
"value": "RES"
}
]
},
{
"id": "990000",
"name": "Residential",
"role": "marketingCategory"
}
],
"contact": [
{
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street1": "Lot 174c South Haven",
"street2": " South Haven",
"city": "Yallahs",
"stateOrProvince": "St Thomas",
"country": "Jamaica",
"postCode": "00000"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "1234567"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "waynethom@gmail.com"
}
}
]
},
{
"contactName": "WAYNE THOMPSON",
"partyRoleType": "OWNER",
"contactMedium": [
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "waynethom@gmail.com",
"contactType": "billEmail"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "waynethom@gmail.com",
"contactType": "email"
}
},
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "8763306113",
"contactType": "mobile1"
}
},
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "mobile2"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "home"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "phone"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "work"
}
},
{
"mediumType": "Fax",
"characteristic": {
"faxNumber": "84786620",
"contactType": "fax"
}
},
{
"mediumType": "IVR",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "ivr"
}
},
{
"mediumType": "IVR",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "ivr1"
}
},
{
"mediumType": "IVR",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "ivr2"
}
},
{
"mediumType": "IVR",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "ivr3"
}
}
]
},
{
"contactName": "Fay Thompson",
"partyRoleType": "RELAT",
"contactMedium": [
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "8764786620",
"contactType": "mobile1"
}
}
]
}
],
"creditLimit": {
"unit": "JMD",
"value": 0
},
"defaultPaymentMethod": {
"id": "E",
"name": "Electronic"
},
"financialAccount": {
"id": "203004460000",
"@referredType": "FinancialAccount"
},
"accountRelationship": [
{
"account": {
"name": ""
},
"relationshipType": "MigratedBillingSystem"
}
],
"sourceBSS": "LIBERATE",
"service": {
"id": "18768335790",
"state": "W",
"prepaidIndicator": false,
"serviceType": "CE"
}
}
cURL request for HFC-Cerillion
curl --location 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/billingAccount/service/18766346821' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b'Response for HFC-Cerillion
{
"id": "12386701",
"href": "https://esb-test.lla.com/tmf-api/accountManagement/v1/JM/billingAccount/12386701",
"accountType": "RES",
"name": "CHRISTOPHER DUNKLEY",
"paymentStatus": "In Arrears",
"state": "SN",
"accountBalance": [
{
"amount": {
"unit": "JMD",
"value": 8055
},
"balanceType": "LastPaymentAmount",
"validFor": {
"endDateTime": "2024-06-13T17:31:13.000Z"
}
},
{
"amount": {
"unit": "JMD",
"value": 16942.94
},
"balanceType": "CurrentBalance"
},
{
"amount": {
"unit": "JMD",
"value": 16942.94
},
"balanceType": "OverdueBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "WrittenOffAmount"
},
{
"amount": {
"unit": "JMD",
"value": 16942.94
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"unit": "JMD",
"value": 16942.94
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2024-08-28T00:00:00.000Z"
}
},
{
"amount": {
"unit": "JMD",
"value": 16942.94
},
"balanceType": "LedgerBalance"
}
],
"billStructure": {
"cycleSpecification": {
"paymentDueDate": "2024-08-28T00:00:00.000Z",
"id": "JMT",
"billingDay": 1
},
"presentationMedia": [
{
"id": "E",
"name": "EMAIL"
},
{
"id": "en-us",
"name": "BillLanguage"
}
]
},
"paymentPlan": [
{
"status": "true",
"@type": "SupportsRecurringPayments"
}
],
"relatedParty": [
{
"id": "12386701",
"name": "CHRISTOPHER DUNKLEY",
"role": "customer",
"@type": "Customer",
"@referredType": "Customer",
"@baseType": "RelatedParty",
"characteristic": [
{
"name": "Customer Identity",
"valueType": "array",
"value": [
{
"DocumentType": "TRN",
"DocumentNumber": "102430322",
"DocumentDescription": "TRN Number"
}
]
},
{
"@referredType": "Customer",
"name": "Date-Of-Birth",
"value": "26-Mar-1959 00:00:00",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "Title",
"value": "MR",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "FirstName",
"value": "CHRISTOPHER",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "LastName",
"value": "DUNKLEY",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "CompanyName",
"value": "DUNKLEY",
"valueType": "string"
}
]
},
{
"@referredType": "Customer",
"id": "23170"
},
{
"@referredType": "Account",
"id": "ST"
}
],
"contact": [
{
"contactName": "CHRISTOPHER DUNKLEY",
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"addressLines1": "3",
"street2": "SANDY LANE",
"postCode": "00020"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "CHRISMUZIKDUNKS84@YAHOO.COM",
"contactType": "billEmail"
}
}
]
},
{
"contactName": "CHRISTOPHER DUNKLEY",
"contactType": "primary",
"contactMedium": [
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8767712922",
"contactType": "business"
}
},
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "(876) 853-1212",
"contactType": "mobile_no"
}
},
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "(876) 853-1212",
"contactType": "mobile"
}
},
{
"mediumType": "Fax",
"characteristic": {
"faxNumber": "8769784312",
"contactType": "fax_no"
}
},
{
"mediumType": "Fax",
"characteristic": {
"faxNumber": "8769784212",
"contactType": "fax"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8764626145",
"contactType": "home"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8764626145",
"contactType": "phone_no"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "shanapittison@gmail.com",
"contactType": "email1"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "shanapittison@gmail.com",
"contactType": "email2"
}
}
]
},
{
"contactName": "Monique Mills",
"contactType": "secondary",
"contactMedium": [
{
"mediumType": "Mobile",
"characteristic": {
"phoneNumber": "8764626145",
"contactType": "mobile_no"
}
}
]
}
],
"financialAccount": {
"id": "12386701"
},
"sourceBSS": "CERILLION",
"service": {
"id": "18766346821",
"state": "CU",
"prepaidIndicator": false,
"serviceType": "TP"
}
}